Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reference for checkoutAgreement GraphQl query #4943

Merged
merged 4 commits into from
Jul 24, 2019
Merged

Reference for checkoutAgreement GraphQl query #4943

merged 4 commits into from
Jul 24, 2019

Conversation

pmclain
Copy link
Contributor

@pmclain pmclain commented Jul 12, 2019 •
edited by meker12
Loading

Purpose of this pull request

Reference for checkoutAgreement GraphQl query

Fixes magento/graphql-ce#767

Links to Magento source code

https://github.com/magento/graphql-ce/blob/c3040e682d56964b78c6e7a29388bea6c1a34c85/app/code/Magento/CheckoutAgreementsGraphQl/etc/schema.graphqls#L4-L21

whatsnew
Added the checkoutAgreements query topic to the GraphQL Developer Guide.

@devops-devdocs
Copy link
Collaborator

An admin must run tests on this PR before it can be merged.

@osrecio osrecio self-assigned this Jul 12, 2019
@osrecio osrecio added New Topic A major update published as an entirely new document 2.3.x Magento 2.3 related changes Technical Updates to the code or processes that alter the technical content of the doc labels Jul 12, 2019
@jeff-matthews jeff-matthews removed the Technical Updates to the code or processes that alter the technical content of the doc label Jul 12, 2019
@keharper keharper self-assigned this Jul 16, 2019
osrecio
osrecio approved these changes Jul 18, 2019
View reviewed changes
Copy link
Member

@osrecio osrecio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested locally and works fine. I can approve this PR technically

@keharper keharper added the Community Docs impacted by community code contribution label Jul 18, 2019
keharper
keharper requested changes Jul 22, 2019
View reviewed changes
Copy link
Contributor

@keharper keharper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've confirmed that checkoutAgreements has been merged into 2.3.3, so I'm ready to merge this PR, pending some changes.

guides/v2.3/graphql/reference/checkout-aggreements.md Outdated
@@ -0,0 +1,71 @@
---
group: graphql
title: Directory endpoint
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Directory endpoint
title: checkoutAgreements query

guides/v2.3/graphql/reference/checkout-aggreements.md Outdated
---

To retrieve enabled checkout agreements. The query will always return an empty array when
`checkout/options/enable_agreements` is disabled.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`checkout/options/enable_agreements` is disabled.
the **Enable Terms and Conditions** option is set to **No**. (The config path is `checkout/options/enable_agreements`.)

guides/v2.3/graphql/reference/checkout-aggreements.md Outdated
contributor_link: https://www.somethingdigital.com/
---

To retrieve enabled checkout agreements. The query will always return an empty array when
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To retrieve enabled checkout agreements. The query will always return an empty array when
The `checkoutAgreements` query retrieves checkout agreements. The query will always return an empty array when

guides/v2.3/graphql/reference/checkout-aggreements.md Outdated
- AUTO
- MANUAL

#### Syntax
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Syntax
## Syntax

guides/v2.3/graphql/reference/checkout-aggreements.md Outdated Show resolved Hide resolved
guides/v2.3/graphql/reference/checkout-aggreements.md Outdated Show resolved Hide resolved
guides/v2.3/graphql/reference/checkout-aggreements.md Outdated Show resolved Hide resolved
guides/v2.3/graphql/reference/checkout-aggreements.md Outdated Show resolved Hide resolved
guides/v2.3/graphql/reference/checkout-aggreements.md Outdated
`is_html` | Boolean | Is Checkout Agreement content in HTML format
`mode` | [CheckoutAgreementMode](#checkoutAgreementMode) | An array of regions within a particular country

### CheckoutAgreementMode enumerable {#checkoutAgreementMode}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this section

guides/v2.3/graphql/reference/checkout-aggreements.md Show resolved Hide resolved
@keharper
Copy link
Contributor

@pmclain For 2.3.3, I'm getting rid of all "XYZ endpoint" topics. Instead, I'll document each query and mutation separately. I've barely begun this process, and I haven't created any query docs, but you can see the first of the mutations here:

https://github.com/magento/devdocs/blob/develop/guides/v2.3/graphql/mutations/apply-store-credit.md

I'd like each topic to have this layout:

  • Introductory paragraphs (no heading)
  • Example usage
  • Input attributes (iff applicable)
  • Output attributes

If you would move the CheckoutAgreement attributes section to the bottom, I'll be ready to merge this PR. (I'll move the topic and add navigation later.)

@keharper
Copy link
Contributor

running tests

@keharper keharper merged commit cb360ba into magento:develop Jul 24, 2019
@ghost
Copy link

ghost commented Jul 24, 2019

Hi @pmclain, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@keharper
Copy link
Contributor

Thanks @pmclain

@keharper keharper added xx2.3.3 Magento 2.3.3 changes and removed 2.3.x Magento 2.3 related changes labels Jul 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@osrecio osrecio osrecio approved these changes

@keharper keharper keharper approved these changes

Assignees

@osrecio osrecio

@keharper keharper

@pmclain pmclain

Labels
Community Docs impacted by community code contribution New Topic A major update published as an entirely new document Partner: Something Digital partners-contribution PR created by Magento partner xx2.3.3 Magento 2.3.3 changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@pmclain @devops-devdocs @keharper @osrecio @jeff-matthews @magento-engcom-team